POST Switch Channels for Live Video

Overview

The table below provides key details about the POST method for switching channels for Live Video.

POST Switch Channels for Live Video
Method	POST
URL or Endpoint	/api/v1/`projectId`/live-videos/`switch-channel`
Headers	Authorization
Parameters	projectId
Request Body	videoId, channelId

The description of the URL parameter is as follows:

Request Body

{
  "videoId": "{videoId}",
  "channelId": "{channelId}"
}

The description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
videoId	Yes	string	Unique identifier of the live video
channelId	No	string	Unique identifier for the channel

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": true,
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	bool	Returns a boolean value indicating the success or failure of the request.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: